package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.EmpEducationRequireAddDTO;
import org.jsola.hr.dto.EmpEducationRequireUpdateDTO;
import org.jsola.hr.query.EmpEducationRequireQuery;
import org.jsola.hr.vo.EmpEducationRequireListVO;
import org.jsola.hr.vo.EmpEducationRequireVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-公司员工教育经历所需信息")
public interface IEmpEducationRequireControllerAPI {

    /**
     * 新增公司员工教育经历所需信息
     * @param empEducationRequireAddDTO 公司员工教育经历所需信息新增实体
     * @return 公司员工教育经历所需信息展示对象
     */
    @ApiOperation(value = "新增公司员工教育经历所需信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empEducationRequireAddDTO", dataType = "EmpEducationRequireAddDTO", value = "新增公司员工教育经历所需信息", paramType = "body")
    })
    Result<EmpEducationRequireVO> save(EmpEducationRequireAddDTO empEducationRequireAddDTO);


    /**
     * 修改公司员工教育经历所需信息
     * @param empEducationRequireUpdateDTO 公司员工教育经历所需信息
     * @return 更新数量
     */
    @ApiOperation(value = "修改公司员工教育经历所需信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empEducationRequireUpdateDTO", dataType = "EmpEducationRequireUpdateDTO", value = "修改公司员工教育经历所需信息", paramType = "body")
    })
    Result<Integer> update(EmpEducationRequireUpdateDTO empEducationRequireUpdateDTO);




    /**
     * 删除单个公司员工教育经历所需信息，彻底删除
     * @param empEducationRequireId 公司员工教育经历所需信息id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个公司员工教育经历所需信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empEducationRequireId", dataType = "String", value = "公司员工教育经历所需信息id", paramType = "path")
    })
    Result<Integer> delete(String empEducationRequireId);


    /**
     * 批量删除公司员工教育经历所需信息，彻底删除
     * @param empEducationRequireIds 公司员工教育经历所需信息id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除公司员工教育经历所需信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empEducationRequireIds", dataType = "String[]", value = "公司员工教育经历所需信息id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] empEducationRequireIds);


    /**
     * 根据公司员工教育经历所需信息id查询公司员工教育经历所需信息详情
     * @param empEducationRequireId 公司员工教育经历所需信息id
     * @return 公司员工教育经历所需信息详情
     */
    @ApiOperation(value="根据公司员工教育经历所需信息id查询公司员工教育经历所需信息详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empEducationRequireId", dataType = "String", value = "公司员工教育经历所需信息id", paramType = "path")
    })
    Result<EmpEducationRequireVO> findById(String empEducationRequireId);


    /**
     * 查询公司员工教育经历所需信息
     * @param empEducationRequireQuery 公司员工教育经历所需信息查询参数
     * @return page
     */
    @ApiOperation(value="查询公司员工教育经历所需信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empEducationRequireQuery", dataType = "EmpEducationRequireQuery", value = "公司员工教育经历所需信息查询参数", paramType = "query")
    })
    Result<List<EmpEducationRequireListVO>> listAll(EmpEducationRequireQuery empEducationRequireQuery);


     /**
     * 分页查询公司员工教育经历所需信息
     * @param empEducationRequireQuery 公司员工教育经历所需信息查询参数
     * @return page
     */
    @ApiOperation(value="分页查询公司员工教育经历所需信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empEducationRequireQuery", dataType = "EmpEducationRequireQuery", value = "公司员工教育经历所需信息查询参数", paramType = "query")
    })
    Result<Page<EmpEducationRequireListVO>> page(EmpEducationRequireQuery empEducationRequireQuery);


}

